Post-process flatc jsonschema output into rich schema - #474
Open
Thomas-Mikhael wants to merge 1 commit into
Open
Post-process flatc jsonschema output into rich schema#474Thomas-Mikhael wants to merge 1 commit into
Thomas-Mikhael wants to merge 1 commit into
Conversation
schema_generator.py can rebuild the json schema shared defs (based on fbs comment tokens)
Thomas-Mikhael
requested review from
4og,
antonkri,
fbaeuerle and
pawelrutkaq
as code owners
August 14, 2026 15:49
github-actions
Bot
added
comp-flatbuffers
Contributor
|
Documentation preview for this pull request is available at: |
There was a problem hiding this comment.
Pull request overview
Adds post-processing to generate richer draft-2020-12 JSON schemas from FlatBuffers definitions.
Changes:
- Adds metadata extraction, reference inlining, and shared
$defs. - Integrates the generator into the Bazel rule.
- Registers the generator as an executable Bazel target.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
score/flatbuffers/bazel/tools.bzl |
Runs schema post-processing after flatc. |
score/flatbuffers/bazel/schema_generator.py |
Implements schema enrichment. |
score/flatbuffers/bazel/BUILD |
Defines the generator executable. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+174
to
+180
| properties = {} | ||
| required = [] | ||
| for field_name, field_node in def_node.get("properties", {}).items(): | ||
| built, is_required = self.build_field(field_node) | ||
| properties[field_name] = built | ||
| if is_required: | ||
| required.append(field_name) |
Comment on lines
+142
to
+144
| # Scalar / string / bool leaf. | ||
| meta, desc = _parse_description(node.get("description", "")) | ||
| out = {"type": node_type} |
Comment on lines
+127
to
+129
| # Non-shared table reference -> inline it. Such fields are authored bare | ||
| # (metadata lives on the referenced table), so they are never required here. | ||
| return self.build_object(self._defs[ref]), False |
Comment on lines
+139
to
+140
| out["items"] = self._build_items(node["items"]) | ||
| return out, meta["required"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
schema_generator.py can rebuild the json schema shared defs (based on fbs comment tokens)